Skip to main content

GetRange

Returns an object that represents the selected range of the current sheet. Can be a single cell - A1, or cells from a single row - A1:E1, or cells from a single column - A1:A10, or cells from several rows and columns - A1:E10.

Syntax

expression.GetRange(Range1, Range2);

expression - A variable that represents a ApiWorksheet class.

Parameters

NameRequired/OptionalData typeDefaultDescription
Range1RequiredstringApiRange
Range2RequiredstringApiRange

Returns

ApiRange | null

Example

This example shows how to get an object that represents the selected range of the sheet.

var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("A2").SetValue("2");
var oRange = oWorksheet.GetRange("A1:D5");
oRange.SetAlignHorizontal("center");